<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class IRCBot_Loop</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1' />
</head>
<body>
	<div class="page-body">
		<h2 class="class-name">Class IRCBot_Loop</h2>

		<a name="sec-description"></a>
		<div class="info-box">
			<div class="info-box-title">Description</div>
			<div class="nav-bar">
				<span class="disabled">Description</span> | <a
					href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

			</div>
			<div class="info-box-body">
				<!-- ========== Info from phpDoc block ========= -->
				<p class="short-description">The IRCBot loop</p>
				<p class="description">
					<p>The loop wich will maintain all the events and will handle
						various of events</p>
				</p>
				<ul class="tags">
					<li><span class="field">author:</span> Marlin Cremers &lt;<a
						href="mailto:marlinc@mms-projects.net">marlinc@mms-projects.net</a>&gt;</li>
					<li><span class="field">link:</span> <a
						href="https://github.com/Marlinc/IRCBot">https://github.com/Marlinc/IRCBot</a></li>
					<li><span class="field">license:</span> <a
						href="http://www.freebsd.org/copyright/freebsd-license.html">BSD
							License (2 Clause)</a></li>
				</ul>
				<p class="notes">
					Located in <a class="field" href="_Loop.php.html">/Loop.php</a>
					(line <span class="field">21</span>)
				</p>


				<pre></pre>

			</div>
		</div>



		<a name="sec-var-summary"></a>
		<div class="info-box">
			<div class="info-box-title">
				Variable Summary</span>
			</div>
			<div class="nav-bar">
				<a href="#sec-description">Description</a> | <span class="disabled">Vars</span>
				(<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a>
				(<a href="#sec-methods">details</a>)

			</div>
			<div class="info-box-body">
				<div class="var-summary">
					<div class="var-title">
						<span class="var-type">int</span> <a href="#$iterations"
							title="details" class="var-name">$iterations</a>
					</div>
				</div>
			</div>
		</div>

		<a name="sec-method-summary"></a>
		<div class="info-box">
			<div class="info-box-title">
				Method Summary</span>
			</div>
			<div class="nav-bar">
				<a href="#sec-description">Description</a> | <a
					href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

				| <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
			</div>
			<div class="info-box-body">
				<div class="method-summary">

					<div class="method-definition">
						<span class="method-result">void</span> <a href="#onIterate"
							title="details" class="method-name">onIterate</a> (<span
							class="var-type">int</span>&nbsp;<span class="var-name">$iteration</span>)
					</div>
					<div class="method-definition">
						<span class="method-result">void</span> <a href="#onStart"
							title="details" class="method-name">onStart</a> ()
					</div>
					<div class="method-definition">
						<span class="method-result">int</span> <a href="#startLoop"
							title="details" class="method-name">startLoop</a> ([<span
							class="var-type">int</span>&nbsp;<span class="var-name">$iterations</span>
						= <span class="var-default">0</span>], [<span class="var-type">callback</span>&nbsp;<span
							class="var-name">$onStart</span> = <span class="var-default">null</span>],
						[<span class="var-type">callback</span>&nbsp;<span
							class="var-name">$onIterate</span> = <span class="var-default">null</span>])
					</div>
				</div>
			</div>
		</div>

		<a name="sec-vars"></a>
		<div class="info-box">
			<div class="info-box-title">Variables</div>
			<div class="nav-bar">
				<a href="#sec-description">Description</a> | <a
					href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


				| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

			</div>
			<div class="info-box-body">
				<a name="var$iterations" id="$iterations">
					<!-- -->
				</A>
				<div class="oddrow">

					<div class="var-header">
						<span class="var-title"> <span class="var-type">int</span>
							<span class="var-name">$iterations</span> = <span
							class="var-default"> 0</span> (line <span class="line-number">27</span>)
						</span>
					</div>

					<!-- ========== Info from phpDoc block ========= -->
					<p class="short-description">The number number iterations</p>
					<ul class="tags">
						<li><span class="field">access:</span> public</li>
					</ul>





				</div>

			</div>
		</div>

		<a name="sec-methods"></a>
		<div class="info-box">
			<div class="info-box-title">Methods</div>
			<div class="nav-bar">
				<a href="#sec-description">Description</a> | <a
					href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

			</div>
			<div class="info-box-body">
				<A NAME='method_detail'></A> <a name="methodonIterate"
					id="onIterate">
					<!-- -->
				</a>
				<div class="evenrow">

					<div class="method-header">
						<span class="method-title">onIterate</span> (line <span
							class="line-number">77</span>)
					</div>

					<!-- ========== Info from phpDoc block ========= -->
					<p class="short-description">Gets executed every time the loop
						iterates</p>
					<ul class="tags">
						<li><span class="field">access:</span> public</li>
					</ul>

					<div class="method-signature">
						<span class="method-result">void</span> <span class="method-name">
							onIterate </span> (<span class="var-type">int</span>&nbsp;<span
							class="var-name">$iteration</span>)
					</div>

					<ul class="parameters">
						<li><span class="var-type">int</span> <span class="var-name">$iteration</span><span
							class="var-description">: The amount of iterations done</span></li>
					</ul>


				</div>
				<a name="methodonStart" id="onStart">
					<!-- -->
				</a>
				<div class="oddrow">

					<div class="method-header">
						<span class="method-title">onStart</span> (line <span
							class="line-number">65</span>)
					</div>

					<!-- ========== Info from phpDoc block ========= -->
					<p class="short-description">Gets executed ones the loop is
						started</p>
					<ul class="tags">
						<li><span class="field">access:</span> public</li>
					</ul>

					<div class="method-signature">
						<span class="method-result">void</span> <span class="method-name">
							onStart </span> ()
					</div>



				</div>
				<a name="methodstartLoop" id="startLoop">
					<!-- -->
				</a>
				<div class="evenrow">

					<div class="method-header">
						<span class="method-title">startLoop</span> (line <span
							class="line-number">38</span>)
					</div>

					<!-- ========== Info from phpDoc block ========= -->
					<p class="short-description">This method will start the
						infinite loop</p>
					<ul class="tags">
						<li><span class="field">return:</span> Returns the amount of
							iterations runned</li>
						<li><span class="field">access:</span> public</li>
					</ul>

					<div class="method-signature">
						<span class="method-result">int</span> <span class="method-name">
							startLoop </span> ([<span class="var-type">int</span>&nbsp;<span
							class="var-name">$iterations</span> = <span class="var-default">0</span>],
						[<span class="var-type">callback</span>&nbsp;<span
							class="var-name">$onStart</span> = <span class="var-default">null</span>],
						[<span class="var-type">callback</span>&nbsp;<span
							class="var-name">$onIterate</span> = <span class="var-default">null</span>])
					</div>

					<ul class="parameters">
						<li><span class="var-type">int</span> <span class="var-name">$iterations</span><span
							class="var-description">: The number of iterations to run</span>
						</li>
						<li><span class="var-type">callback</span> <span
							class="var-name">$onStart</span><span class="var-description">:
								The callback to call if the loop started</span></li>
						<li><span class="var-type">callback</span> <span
							class="var-name">$onIterate</span><span class="var-description">:
								The callback to call every time to loop iterates</span></li>
					</ul>


				</div>

			</div>
		</div>


		<p class="notes" id="credit">
			Documentation generated on Wed, 04 Jan 2012 16:59:21 +0100 by <a
				href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
		</p>
	</div>
</body>
</html>